<html>
<head><meta charset="utf-8"><title>howto build rustc api docs · t-compiler/help · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/index.html">t-compiler/help</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html">howto build rustc api docs</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="208460627"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208460627" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Tshepang Lekhonkhobe <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208460627">(Aug 30 2020 at 00:13)</a>:</h4>
<p>I have the following config.toml</p>
<div class="codehilite"><pre><span></span><code>[build]
compiler-docs = true
extended = true
tools = [ &quot;clippy&quot;, &quot;rustfmt&quot;, &quot;rust-analyzer&quot; ]
target = [ &quot;wasm32-unknown-unknown&quot; ]

[rust]
incremental = true
lld = true
</code></pre></div>


<p>To build docs, I run the following</p>
<div class="codehilite"><pre><span></span><code>/x.py doc --stage 1 --target x86_64-unknown-linux-gnu
</code></pre></div>


<p>That results is library docs, but no compiler docs</p>



<a name="208460866"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208460866" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208460866">(Aug 30 2020 at 00:21)</a>:</h4>
<p>Deja Vu <span aria-label="laughing" class="emoji emoji-1f606" role="img" title="laughing">:laughing:</span> didn't you have this working a while ago?</p>



<a name="208460904"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208460904" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208460904">(Aug 30 2020 at 00:22)</a>:</h4>
<p>They'd be in <code>build/x86_64.../compiler-docs</code>, is there anything there?</p>



<a name="208460967"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208460967" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Tshepang Lekhonkhobe <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208460967">(Aug 30 2020 at 00:25)</a>:</h4>
<p>it's now an empty dir</p>



<a name="208461012"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208461012" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Tshepang Lekhonkhobe <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208461012">(Aug 30 2020 at 00:26)</a>:</h4>
<p><span class="user-mention silent" data-user-id="232545">Joshua Nelson</span> <a href="#narrow/stream/182449-t-compiler.2Fhelp/topic/howto.20build.20rustc.20api.20docs/near/208460866">said</a>:</p>
<blockquote>
<p>Deja Vu <span aria-label="laughing" class="emoji emoji-1f606" role="img" title="laughing">:laughing:</span> didn't you have this working a while ago?</p>
</blockquote>
<p>yeah, but hasn't been working for some weeks now, I think since <code>x.py changes</code></p>



<a name="208464298"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208464298" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208464298">(Aug 30 2020 at 02:14)</a>:</h4>
<p>hmm ... what happens if you use <code>doc src/librustc_resolve</code> or some other rustc crate?</p>



<a name="208464303"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208464303" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208464303">(Aug 30 2020 at 02:14)</a>:</h4>
<p>I think not building the compiler by default might have also not built the docs by default (oops)</p>



<a name="208467011"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/howto%20build%20rustc%20api%20docs/near/208467011" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> lzutao <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/howto.20build.20rustc.20api.20docs.html#208467011">(Aug 30 2020 at 03:53)</a>:</h4>
<p>what if you use <code>x.py doc src/rustc</code> instead ?</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>